<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Line Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">Line Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Lines to add graphical interest to a report.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Line</td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>XML Element:</td>
<td><code>line</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ReportItem.html">ReportItem</a></td></tr>
<tr><td>Extendable:</td>
<td>Yes</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>Report Items</td></tr>
<tr><td>Name Requirement:</td>
<td>Optional</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>Yes</td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#line">line</a></td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-orientation">orientation</a></dt>
<dd>The orientation of the line: Horizontal (default) or Vertical.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportItem.html#Property-ACLExpression">ACLExpression</a>, 
<a href="ReportItem.html#Property-allowExport">allowExport</a>, 
<a href="ReportItem.html#Property-bookmark">bookmark</a>, 
<a href="ReportItem.html#Property-bookmarkDisplayName">bookmarkDisplayName</a>, 
<a href="ReportItem.html#Property-boundDataColumns">boundDataColumns</a>, 
<a href="ReportItem.html#Property-cascadeACL">cascadeACL</a>, 
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="ReportItem.html#Property-cube">cube</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportItem.html#Property-dataBindingRef">dataBindingRef</a>, 
<a href="ReportItem.html#Property-dataSet">dataSet</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="ReportItem.html#Property-height">height</a>, 
<a href="ReportItem.html#Property-multiViews">multiViews</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="ReportItem.html#Property-paramBindings">paramBindings</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="ReportItem.html#Property-pushDown">pushDown</a>, 
<a href="ReportItem.html#Property-refTemplateParameter">refTemplateParameter</a>, 
<a href="ReportItem.html#Property-style">style</a>, 
<a href="ReportItem.html#Property-toc">toc</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>, 
<a href="ReportItem.html#Property-visibility">visibility</a>, 
<a href="ReportItem.html#Property-width">width</a>, 
<a href="ReportItem.html#Property-x">x</a>, 
<a href="ReportItem.html#Property-y">y</a>, 
<a href="ReportItem.html#Property-zIndex">zIndex</a>
</p>
<h3>Style Properties</h3>

<p class="section-text">
<a href="Style.html#Property-borderBottomColor">borderBottomColor</a>, 
<a href="Style.html#Property-borderBottomStyle">borderBottomStyle</a>, 
<a href="Style.html#Property-borderBottomWidth">borderBottomWidth</a>, 
<a href="Style.html#Property-borderLeftColor">borderLeftColor</a>, 
<a href="Style.html#Property-borderLeftStyle">borderLeftStyle</a>, 
<a href="Style.html#Property-borderLeftWidth">borderLeftWidth</a>, 
<a href="Style.html#Property-borderRightColor">borderRightColor</a>, 
<a href="Style.html#Property-borderRightStyle">borderRightStyle</a>, 
<a href="Style.html#Property-borderRightWidth">borderRightWidth</a>, 
<a href="Style.html#Property-borderTopColor">borderTopColor</a>, 
<a href="Style.html#Property-borderTopStyle">borderTopStyle</a>, 
<a href="Style.html#Property-borderTopWidth">borderTopWidth</a>, 
<a href="Style.html#Property-display">display</a>, 
<a href="Style.html#Property-paddingBottom">paddingBottom</a>, 
<a href="Style.html#Property-paddingLeft">paddingLeft</a>, 
<a href="Style.html#Property-paddingRight">paddingRight</a>, 
<a href="Style.html#Property-paddingTop">paddingTop</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p>Customers often use lines and rectangles to add graphical interest to a report. 
For example, the customer may draw a box around certain fields to group them. Or,
the customer may use alternating background colors to improve report legibility.

<p>Most reports are intended for viewing on the web. Web browsers generally support 
only horizontal and vertical, but not diagonal lines. Diagonal lines require an image 
which imposes extra cost and is difficult to correctly format. So, BRD limits support 
to horizontal and vertical lines, but not diagonal lines. 

<p>The user can set the line size, line color and line pattern using the item's style.

<p>A line item describes a line along the edge of a rectangle. If orientation is vertical, 
the line is along the left edge of the bounding box. If the line is horizontal, the line 
is along the top edge of the bounding box. That is, the X and Y properties give the line 
origin. The Width property gives the length of horizontal lines, the Height property gives 
the width of vertical lines.</div>
<h1>Property Detail</h1>

<h2><a name="Property-orientation">orientation Property</a></h2>

<p class="section-text">The orientation of the line: Horizontal (default) or Vertical.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (lineOrientation)</td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Orientation</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>horizontal</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>horizontal</td>
<td>Horizontal</td>
<td>horizontal</td>
<td></td></tr>
<tr><td>vertical</td>
<td>Vertical</td>
<td>vertical</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>Orientation of the line.</div>
</body>
</html>
